Decommissioning process

The decommissioning (or sunsetting) process for APIs in the BTG Empresas ecosystem is communicated to API consumers in a clear, standardized, and advance manner. To do this, in addition to communication by email, we use the following HTTP headers:

Sunset – Indicates the date on which the API will be officially discontinued.

Deprecation – Indicates whether the resource is deprecated.

Link – Provides links related to the decommissioning, such as documentation and alternative API versions.

The use of these headers complies with the Sunset and Deprecation RFCs. Example of how we use them:

Deprecation: true
Link: <https://api.exemplo.com/docs/v1-deprecated>; rel="deprecation; type="text/html"
Sunset: Sat, 11 Oct 2025 00:36:36 GMT